Installation

===============================================================================
Not needed if you are using NitrOS-9 EOU 1.0.2 or later:
To execute the Install program in the CMDS directory to copy the game files to
your hard drive, use the Install batch file in the root directory of the
SokobanOG floppy disk.
===============================================================================

The DATA, SCREENS and SCREENS2 directories must be in the directory where you
want to play the game from. The DATA directory must contain all of its files,
except for gameDat. That file, as well as the SNAPSHOTS directory and the
SnapShots.DAT file it contains, will be created as long as all other required
files/directories exist.

Make sure you are CHD'd to the SokobanOG directory when you play the game, as
SOKOBANOG will inform you they are not found and end if it can't find the
required files/directories.

The following are provided for use with Multi-Vue:
CMDS/ICONS subdirectory contents copied to: /DD/CMDS/ICONS subdirectory
SYS/HELP subdirectory contents copied to: /DD/SYS/HELP directory
The AIF files located in the SokobanOG directory.

===============================================================================

Version 1.50.00 files:
    CMDS directory
      ICONS subdirectory
        icon.sokobanog     - SokobanOG icon for MV
        icon.gamedata      - GameData icon for MV
        icon.snapshots     - Snapshots icon for MV
      SOKOBANOG            - the game main modules
      CheckFiles           - the game secondary modules
      Install              - Install program for v2.01.00
      GameData             - gameDat viewer/editor program
      SnapShots            - Snapshot viewer/editor program
    SYS directory
      HELP subdirectory    - help files for MV
        SokobanOG.hlp      - game quick help
        GameData.hlp       - GameData quick help
        SnapShots.hlp      - SnapShots quick help
    DATA directory
      HBUFF.DAT            - game sprites
      gameDat              - game progress
      setDat               - sets 5-10 puzzle name numbers file
      dirDat               - start direction data file (all puzzles)
      ScoresDat            - level scores data file (all sets)
      About.txt            - About overlay data
      Instruction.txt      - Instruction overlay data
    SNAPSHOTS directory
      SnapShots.DAT        - snapshots data file
    SCREENS directory
      SCREEN1.DAT through  - Sokoban 1, 1b and 2
      SCREEN80.DAT         - puzzle files
    SCREENS2 directory
      SCREEN1.DAT through  - MS-Dos, Color Computer, Apple 2,
      SCREEN50a.DAT        - Commodore 64 and XSokoban puzzle files
    Install                - batch file to run the Install module
    ReadMe_Sokoban.txt     - this file
    AIF.sok                - SokobanOG AIF file for MV
    AIF.gam                - GameData AIF file for MV
    AIF.sna                - SnapShots AIF file for MV

===============================================================================

SokobanOG Source disk image files:
    SOURCE directory
      SOKOBANOG.B09        - version 1.50.00 source code file
      CheckFiles.B09       - version 1.50.00 CheckFiles source code file
      GameData.B09         - GameData source code file
      SnapShots.B09        - SnapShots source code file
      Install.B09          - Install source code file
    SUBORD directory
      ProgramVariables.txt - variable definitions for v1.50.00
      procsize.txt         - Procedure and disk file size data
      SokobanOGID.txt      - ident info an all game-related modules
    DATAMOD
      datamod.c            - test data module c source
      DataMod.B09          - test data module load/link/unlink/unload Basic09 source
      datamod.a            - test data module asm source
      Solution.txt         - data module assembler output
      Solution             - data module
      Solution.a           - data module asm source

===============================================================================

Program use:

To start the game, type 'runb sokobanog' (without the quotes) at the system
prompt. The window you start in will be restored when you quit the game.

NOTE: If you are using Multi-Vue, simply go to the SOKOBANOG folder following
the path you used for installation (/DD is the default unless you are using
EOU) and double click the SOKOBANOG icon. The SOKOBANOG folder in EOU is located
at /DD/GAMES/LEVEL2/STRATEGY/.

NOTE: If you don't include the 'runb ' before 'sokobanog', shell+ will
report a 43 (procedure not found) error. This is due to a bug in shell+
which also existed in the original shell.

From the Start screen you can type "I" to see the instructions for commands on
the Start Screen, and in Gameplay. In Multi-Vue, if you select the SOKOBANOG icon
and click the '?' on the menubar, you will be able to read the quick help file.

For those who want instructions in the ReadMe file:
Start Screen:
============
S = Start from first level in the current set (snapshots if available)
P = Play Set: Choose from the following:
    1 = All levels     (1-80)
    2 = Sokoban 1      (1-20)
    3 = Sokoban 1a     (21-30)
    4 = Sokoban 2      (31-80)
    5 = All US levels  (1-67)
    6 = MS-DOS         (1-50)
    7 = Color Computer (1-50)
    8 = Apple 2        (1-50)
    9 = Commodore 64   (1-50)
   10 = XSokoban       (1-50)
R = Resume at last level played in the currently selected set
    (or next level if last level is completed) (snapshots if available)
G = Goto Level: Choose a level to play, restricted to the
    currently selected set) (snapshots if available, auto-replay if
    complete solution is available)
E = End game
I = Display Instructions overlay (use drop menu or numbers 8,9,A,B,
    B closes overlay)
A = Display About overlay (use drop menu or numbers 1-7,
    7 closes overlay)

If there is a snapshot or a solution for the current level you will be asked
if you want to load the snapshot or solution upon selecting any option from
the Start screen. Choices are Yes or No. If you choose to load a solution
the game will replay the solution automatically.

Gameplay:
========
Arrow keys to move pusher/push boxes
U = Undo last move/push (works with breakable walls)
R = Reset the current level to the beginning (snapshots if available)
P = Display Pause overlay: Options are:
    C = Continue current level
    S = Switch Set: Choose from the following:
        1 = All levels     (1-80)
        2 = Sokoban 1      (1-20)
        3 = Sokoban 1a     (21-30)
        4 = Sokoban 2      (31-80)
        5 = All US levels  (1-67)
        6 = MS-DOS         (1-50)
        7 = Color Computer (1-50)
        8 = Apple 2        (1-50)
        9 = Commodore 64   (1-50)
       10 = XSokoban       (1-50)
    G = Goto Level: Choose a level to play, restricted to the
        currently selected set) (snapshots if available, auto-replay
        if complete solution is available)
    E = End game
    (S,G and E options will prompt to save snapshot if number of moves is
     greater than 0 or any moves made since loading a snapshot)
I = Display Instructions overlay (use drop menu or numbers 8,9,A,B,
    B closes overlay)
A = Display About overlay (use drop menu or numbers 1-7,
    7 closes overlay)

If you have made any moves since loading the puzzle you will be asked if you
want to save the snapshot upon selecting any option other than Continue in the
Pause overlay. Choices are Yes or No.

Instructions overlay screens:
============================
8 = Start screen options
9 = Gameplay/Pause options
A = Current progress:
    Current Set
    Cumulative Moves
    Cumulative Pushes
    Set # (1-10) last completed level
    Contiguous play or not
B - close overlay and return to start screen or gameplay

About overlay screens:
=====================
1 = Basic09 (NitrOS-9) version authorship
2 = BASIC (SECB) version authorship
3 = Sokoban 1 authorship
4 = Sokoban 1a authorship
5 = Sokoban 2 authorship
6 = List of contributors to this version
7 - close overlay and return to start screen or gameplay

SOKOBANOG is version: 1.50.00
Version 1.00.00 added scoring to the game. Scoring is moves and pushes,
and is saved per level per set, culumative per set and cumulative total.
It only applies to levels completed in order, and you can do so in multiple
sets consecutively. The goal is to solve the level(s) with the fewest moves
possible. (Note, there are those who believe that fewer pushes is better.
That is a discussion better left in the discord server.)
Version 1.50.00 added solution replay to the game.

Have fun!

You can find me in the #basic09 channel on the CoCo Discord, or you can email
me at asa.rand@gmail.com if you have questions, complaints, suggestions.

Visit my Sokoban site: https://wayneca.neocities.org/Sokoban/
